﻿
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<!-- saved from url=(0014)about:internet -->
<html xmlns:msxsl="urn:schemas-microsoft-com:xslt" xmlns:mssdk="winsdk" xmlns:script="urn:script" xmlns:build="urn:build" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<meta name="Description" content="To start the server side of the Remote tool, use the following syntax at the command line."/>
<meta name="MSHAttr" content="PreferredSiteName:MSDN"/>
<meta name="MSHAttr" content="PreferredLib:/library/windows/hardware"/>
<title>Remote Server Syntax</title>

<meta name="MS-HAID" content="Remote_35021c40-6256-4db8-9da2-b053a147dbb8.xml"/>


<link rel="STYLESHEET" type="text/css" HREF="../common/backsdk4.css"/>





<style>
html,div { margin: 0; padding: 0;}

body {
	padding: 0px;
	margin: 0px;
	overflow: auto;
	height: 100%;
}

#winchm_template_button{
	float: right;
	width: 93px;
	top: 7px;
	position: relative;
	text-align: right;
	right: 5px;
	height: auto;
}

#winchm_template_top{
	padding: 0px;
	margin: 0px;
	border-bottom: 1px solid #9B9B9B;
	background-color: #B1CEFE;
}

#winchm_template_navigation{
	margin: 0px;
	padding-top: 7px;
	padding-left: 7px;
	padding-bottom: 3px;
	padding-right: 0px;
	font-size: 8.5pt;
	font-family: Arial, Helvetica, sans-serif;
	font-weight: normal;
	color: #585858;
}

#winchm_template_title{
	margin: 0px;
	padding-top: 4px;
	padding-left: 7px;
	padding-bottom: 7px;
	padding-right: 0px;
	font-size: 18px; 
	font-family: Verdana, Geneva, sans-serif;
	color: #363636;
}

#winchm_template_content{
	margin-top: 20px;
	margin-left: 15px;
	margin-bottom: 20px;
	margin-right: 15px;
	width: auto  !important;
	width: 100%;
}

#winchm_template_footer{
	border-width: 1px;
	border-color: #B1CEFE;
	border-top-style: solid;
	margin-top: 15px;
	margin-left: 15px;
	margin-bottom: 20px;
	margin-right: 15px;
	padding-top: 7px;
	padding-left: 0px;
	padding-bottom: 0px;
	padding-right: 0px;
	font-family: arial, helvetica, sans-serif;
	font-size: 8.5pt;
	color: #696969;
	width: auto;
	text-align: left;
}


#winchm_template_container{
	margin: 0px;
	padding: 0px;
	position: static;
	padding-bottom: 3px;
	overflow: auto;
	background-color: #FFFFFF;
}


@media print
{
#winchm_template_container{
	position: static;	
	margin: 0px;
	padding: 5px;
	
	width: auto;
	height: auto;
	overflow: auto;
}
#winchm_template_button{
visibility:hidden;
}
}

#winchm_template_navigation A:link	{text-decoration: none; color:#004080}
#winchm_template_navigation A:visited  {text-decoration: none; color: #004080}
#winchm_template_navigation A:active {text-decoration: none; color: #004080 }
#winchm_template_navigation A:hover {text-decoration: none;color: #0080FF}

A:link	{text-decoration: underline; color:#0033CC}
A:visited  {text-decoration: underline; color: #0033CC}
A:active {text-decoration: underline; color: #0033CC }
A:hover {text-decoration: underline;color: #FF0000;}
</style>
<script type="text/javascript">
function isMobile(){
Agent = window.navigator.userAgent;
if (Agent.indexOf("iPhone")>=1 || Agent.indexOf("iPad")>=1 || Agent.indexOf("iPod")>=1 || Agent.indexOf("Android")>=1){
return true;
}else{
return false;	
}

}
function d_onresize(){
if (window.navigator.userAgent.indexOf("MSIE")>=1){
document.getElementById('winchm_template_container').style.pixelWidth = document.body.offsetWidth - 3;
document.getElementById('winchm_template_container').style.pixelHeight = document.body.offsetHeight - document.getElementById('winchm_template_top').offsetHeight - 4;
}
document.getElementById('winchm_template_container').style.top = document.getElementById('winchm_template_top').offsetHeight + 'px';
}

function d_onbeforeprint(){
document.getElementById('winchm_template_container').style.width = 'auto';
document.getElementById('winchm_template_container').style.height = 'auto';
}

function d_onafterprint(){
d_onresize();
}

if(!isMobile()){

window.onload = d_onresize;
window.onresize = d_onresize;
window.onbeforeprint = d_onbeforeprint;
window.onafterprint = d_onafterprint;

document.write("<style>\n");
document.write("body {overflow: hidden;}\n");
document.write("#winchm_template_container {position: absolute;overflow: auto;top : 0px;right: 0px;bottom: 0px;left: 0px;}\n");
document.write("</style>\n");
}

</script>
</head>
<body><script language="JavaScript" type="text/JavaScript">
function syn(){
if(parent.nav.tree){
 if(parent.nav.tree.loaded){
  parent.nav.tree.selectNode(127);
 }else{
  setTimeout("syn()",500);
}
  }else{
  setTimeout("syn()",500);
  }}
if(parent!=self){
  setTimeout("syn()",100);
}else{
  parent.location.href = "../../index.htm?page=debugger/remote_server_syntax.htm";
}
originalOnload = window.onload;
if(originalOnload==null){
window.onload = function(){parent.contentLoaded = true;};
}else{
window.onload = function(){originalOnload();parent.contentLoaded = true;};
}
</script> 


<div id="winchm_template_top">
	<div id="winchm_template_button"><A href="remote_tool_commands.htm" title="Previous topic"><img id="winchm_template_prev" alt="Previous topic" src="../template2/btn_prev_n.gif" border="0"></a><A href="remote_client_syntax.htm" title="Next topic"><img id="winchm_template_next" alt="Next topic" src="../template2/btn_next_n.gif" border="0"></a></div>
	<div id="winchm_template_navigation">Help &gt; 
<A href="introduction6.htm">Debugging Tools for Windows (WinDbg, KD, CDB, NTSD)</A> &gt; <A href="debugging_resources.htm">Debugging Resources</A> &gt; <A href="extra_tools.htm">Tools Included in Debugging Tools for Windows</A> &gt; <A href="remote_tool.htm">Remote Tool</A> &gt; <A href="remote_tool_commands.htm">Remote Tool Commands</A> &gt; </div>
	<div id="winchm_template_title">Remote Server Syntax</div>
</div>
<div id="winchm_template_container">
	<div id="winchm_template_content"><div id="mainSection"><p>To start the server side of the Remote tool, use the following syntax at the command line. </p>
<pre class="syntax">
    <b>remote /s </b><i>Command</i><b> </b><i>SessionName </i><b>[/f </b><i>Color</i><b>] [/b] [/u </b><i>User</i><b> [/u </b><i>User</i><b>...]] [/ud </b><i>User</i><b> [/ud </b><i>User</i><b>...]] [/v | /-v]
</b>
   </pre>
<h2><a id="ddk_remote_server_syntax_dtools"></a><a id="DDK_REMOTE_SERVER_SYNTAX_DTOOLS"></a>Parameters</h2>
<p></p>
<dl>
<dt><a id="________s______"></a><a id="________S______"></a>       <b>/s</b>      </dt>
<dd>
<p>Starts a server session.</p>
</dd>
<dt><a id="_______Command______"></a><a id="_______command______"></a><a id="_______COMMAND______"></a>       <i>Command</i>      </dt>
<dd>
<p>Specifies the command that starts the console-based program. The command can include parameters. If the command includes spaces, enclose it in quotation marks.</p>
</dd>
<dt><a id="_______SessionName______"></a><a id="_______sessionname______"></a><a id="_______SESSIONNAME______"></a>       <i>SessionName</i>      </dt>
<dd>
<p>Assigns a name to the remote session. If the name includes spaces, enclose it in quotation marks. This parameter is not case-sensitive.</p>
</dd>
<dt><a id="________f______"></a><a id="________F______"></a>       <b>/f</b>      </dt>
<dd>
<p>Specifies the color of the text in the server command window.</p>
</dd>
<dt><a id="________b______"></a><a id="________B______"></a>       <b>/b</b>      </dt>
<dd>
<p>Specifies the background color of the server command window.</p>
</dd>
<dt><a id="_______Color______"></a><a id="_______color______"></a><a id="_______COLOR______"></a>       <i>Color</i>      </dt>
<dd>
<p>Specifies a color. Valid values are black, blue, green, cyan, red, purple, yellow, white, lblack, lblue, lgreen, lred, lpurple, lyellow, and lwhite.</p>
</dd>
<dt><a id="________u______"></a><a id="________U______"></a>       <b>/u</b>      </dt>
<dd>
<p>Specifies users or groups that are permitted to connect to the remote session; by default, everyone is permitted. When you use this parameter, everyone is denied permission, except for the users and groups specified by the <i>User</i> subparameter.</p>
</dd>
<dt><a id="________ud______"></a><a id="________UD______"></a>       <b>/ud</b>      </dt>
<dd>
<p>Specifies users or groups that are denied permission to connect to the remote session; by default, no one is denied permission.</p>
</dd>
<dt><a id="_______User______"></a><a id="_______user______"></a><a id="_______USER______"></a>       <i>User</i>      </dt>
<dd>
<p>Specifies the name of a user or group in [<i>domain</i> | <i>computer</i>]\{<i>user</i> | <i>group</i>} format. When specifying users or groups on the local computer, omit the computer name.</p>
</dd>
<dt><a id="________v______"></a><a id="________V______"></a>       <b>/v</b>      </dt>
<dd>
<p>Makes a session visible. For more information, see <a href="#Bookmark125">Visible Session</a>.</p>
<p>By default, only debugger sessions are visible, that is, sessions in which the value of the <i>Command</i> parameter include the words <b>kd</b>, <b>dbg</b>, <b>remoteds</b>, <b>ntsd</b>, or <b>cdb</b>; otherwise, the session is not visible.</p>
</dd>
<dt><a id="_______-v______"></a><a id="_______-V______"></a>       <b>-v</b>      </dt>
<dd>
<p>Makes a remote debugger session invisible. For more information, see <a href="#Bookmark125">Visible Session</a>. </p>
</dd>
</dl>
<h3><a id="comments"></a><a id="COMMENTS"></a>Comments</h3>
<p>The <i>Command</i> and <i>SessionName</i> parameters must appear in the order shown on the syntax line.</p>
<p>To end a remote session, type <b>@k</b>. For more information, see <a href="#Bookmark130">Remote Session Commands</a>.</p>
<p>The Remote tool will not create a session that the current user does not have permission to join.</p>
<p>When starting more than one remote session on a single computer, open a new command window for each session. Also, use a different session name for each session. Because the session names are used to label the named pipes, they must be unique on the computer.</p>
<h3><a id="sample_usage"></a><a id="SAMPLE_USAGE"></a>Sample Usage</h3>
<div class="code"><span codelanguage=""><table>
<tr>
<th></th>
</tr>
<tr>
<td>
<pre>remote /s "i386kd -v" TestSession
remote /s "cmd" "My Remote Session" /f white /b black /u Server01\Administrators
remote /s "ntsd -d -g -x" DebugIt /-v
remote /q Server01</pre></td></tr></table></span></div></div></div>	
	<div id="winchm_template_footer">Copyright &copy; 2019. All rights 
reserved. (To change the copyright info, just edit it in template.)</div>
</div>

</body>
</html>
